<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="aiplatform_v1.html">Vertex AI API</a> . <a href="aiplatform_v1.projects.html">projects</a> . <a href="aiplatform_v1.projects.locations.html">locations</a> . <a href="aiplatform_v1.projects.locations.trainingPipelines.html">trainingPipelines</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="aiplatform_v1.projects.locations.trainingPipelines.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a TrainingPipeline.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a TrainingPipeline.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists TrainingPipelines in a Location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
  <pre>Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.

Args:
  name: string, Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for PipelineService.CancelTrainingPipeline.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Args:
  parent: string, Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI&#x27;s Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of this TrainingPipeline.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if model_to_upload is not set separately.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the pipeline&#x27;s state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;inputDataConfig&quot;: { # Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. # Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline&#x27;s training_task_definition should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the training_task_definition, then it should be assumed that the TrainingPipeline does not depend on this configuration.
    &quot;annotationSchemaUri&quot;: &quot;A String&quot;, # Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
    &quot;annotationsFilter&quot;: &quot;A String&quot;, # Applicable only to Datasets that have DataItems and Annotations. A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.
    &quot;bigqueryDestination&quot;: { # The BigQuery location for the output content. # Only applicable to custom training with tabular Dataset with BigQuery source. The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name `dataset___` where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, `training`, `validation` and `test`. * AIP_DATA_FORMAT = &quot;bigquery&quot;. * AIP_TRAINING_DATA_URI = &quot;bigquery_destination.dataset___.training&quot; * AIP_VALIDATION_DATA_URI = &quot;bigquery_destination.dataset___.validation&quot; * AIP_TEST_DATA_URI = &quot;bigquery_destination.dataset___.test&quot;
      &quot;outputUri&quot;: &quot;A String&quot;, # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
    },
    &quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline&#x27;s training_task_definition. For tabular Datasets, all their data is exported to training, to pick and choose from.
    &quot;filterSplit&quot;: { # Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as &#x27;-&#x27; (the minus sign). Supported only for unstructured Datasets. # Split based on the provided filters for each set.
      &quot;testFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
      &quot;trainingFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to train the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
      &quot;validationFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to validate the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
    },
    &quot;fractionSplit&quot;: { # Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test. # Split based on fractions defining the size of each set.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;gcsDestination&quot;: { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory. The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: &quot;gs://.../training-*.jsonl&quot; * AIP_DATA_FORMAT = &quot;jsonl&quot; for non-tabular data, &quot;csv&quot; for tabular data * AIP_TRAINING_DATA_URI = &quot;gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}&quot; * AIP_VALIDATION_DATA_URI = &quot;gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}&quot; * AIP_TEST_DATA_URI = &quot;gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}&quot;
      &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. Google Cloud Storage URI to output directory. If the uri doesn&#x27;t end with &#x27;/&#x27;, a &#x27;/&#x27; will be automatically appended. The directory is created if it doesn&#x27;t exist.
    },
    &quot;persistMlUseAssignment&quot;: True or False, # Whether to persist the ML use assignment to data item system labels.
    &quot;predefinedSplit&quot;: { # Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on a predefined key.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The value of the key (either the label&#x27;s value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
    },
    &quot;savedQueryId&quot;: &quot;A String&quot;, # Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.
    &quot;stratifiedSplit&quot;: { # Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value &quot;A&quot;, 25% value &quot;B&quot;, and 25% value &quot;C&quot;, and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value &quot;A&quot; for the specified column, about 25% having the value &quot;B&quot;, and about 25% having the value &quot;C&quot;. Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the distribution of the specified column.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The key provided must be for a categorical column.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;timestampSplit&quot;: { # Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The values of the key (the values in the column) must be in RFC 3339 `date-time` format, where `time-offset` = `&quot;Z&quot;` (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
  },
  &quot;labels&quot;: { # The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;modelId&quot;: &quot;A String&quot;, # Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
  &quot;modelToUpload&quot;: { # A trained machine learning Model. # Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline&#x27;s training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline&#x27;s state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload&#x27;s resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
    &quot;artifactUri&quot;: &quot;A String&quot;, # Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
    &quot;baseModelSource&quot;: { # User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. # Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
      &quot;genieSource&quot;: { # Contains information about the source of the models generated from Generative AI Studio. # Information about the base model of Genie models.
        &quot;baseModelUri&quot;: &quot;A String&quot;, # Required. The public base model URI.
      },
      &quot;modelGardenSource&quot;: { # Contains information about the source of the models generated from Model Garden. # Source information of Model Garden models.
        &quot;publicModelName&quot;: &quot;A String&quot;, # Required. The model garden source model resource name.
        &quot;skipHfModelCache&quot;: True or False, # Optional. Whether to avoid pulling the model from the HF cache.
        &quot;versionId&quot;: &quot;A String&quot;, # Optional. The model garden source model version ID.
      },
    },
    &quot;checkpoints&quot;: [ # Optional. Output only. The checkpoints of the model.
      { # Describes the machine learning model version checkpoint.
        &quot;checkpointId&quot;: &quot;A String&quot;, # The ID of the checkpoint.
        &quot;epoch&quot;: &quot;A String&quot;, # The epoch of the checkpoint.
        &quot;step&quot;: &quot;A String&quot;, # The step of the checkpoint.
      },
    ],
    &quot;containerSpec&quot;: { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
      &quot;args&quot;: [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`&#x27;s &quot;default parameters&quot; form. If you don&#x27;t specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don&#x27;t specify this field and don&#x27;t specify the `command` field, then the container&#x27;s [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        &quot;A String&quot;,
      ],
      &quot;command&quot;: [ # Immutable. Specifies the command that runs when the container starts. This overrides the container&#x27;s [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`&#x27;s &quot;exec&quot; form, not its &quot;shell&quot; form. If you do not specify this field, then the container&#x27;s `ENTRYPOINT` runs, in conjunction with the args field or the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container&#x27;s `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        &quot;A String&quot;,
      ],
      &quot;deploymentTimeout&quot;: &quot;A String&quot;, # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
      &quot;env&quot;: [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { &quot;name&quot;: &quot;VAR_1&quot;, &quot;value&quot;: &quot;foo&quot; }, { &quot;name&quot;: &quot;VAR_2&quot;, &quot;value&quot;: &quot;$(VAR_1) bar&quot; } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        { # Represents an environment variable present in a Container or Python Module.
          &quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
          &quot;value&quot;: &quot;A String&quot;, # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
        },
      ],
      &quot;grpcPorts&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
        { # Represents a network port in a container.
          &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
        },
      ],
      &quot;healthProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
      &quot;healthRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container&#x27;s IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
      &quot;imageUri&quot;: &quot;A String&quot;, # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI&#x27;s [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
      &quot;invokeRoutePrefix&quot;: &quot;A String&quot;, # Immutable. Invoke route prefix for the custom container. &quot;/*&quot; is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: &quot;/invoke/foo/bar&quot;, however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
      &quot;livenessProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
      &quot;ports&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { &quot;containerPort&quot;: 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        { # Represents a network port in a container.
          &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
        },
      ],
      &quot;predictRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container&#x27;s IP address and port. Vertex AI then returns the container&#x27;s response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
      &quot;sharedMemorySizeMb&quot;: &quot;A String&quot;, # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
      &quot;startupProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was uploaded into Vertex AI.
    &quot;dataStats&quot;: { # Stats of data used for train or evaluate the Model. # Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config.
      &quot;testAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.
      &quot;testDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.
      &quot;trainingAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for training this Model.
      &quot;trainingDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for training this Model.
      &quot;validationAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for validating this Model during training.
      &quot;validationDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for validating this Model during training.
    },
    &quot;defaultCheckpointId&quot;: &quot;A String&quot;, # The default checkpoint id of a model version.
    &quot;deployedModels&quot;: [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
      { # Points to a DeployedModel.
        &quot;checkpointId&quot;: &quot;A String&quot;, # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
        &quot;deployedModelId&quot;: &quot;A String&quot;, # Immutable. An ID of a DeployedModel in the above Endpoint.
        &quot;endpoint&quot;: &quot;A String&quot;, # Immutable. A resource name of an Endpoint.
      },
    ],
    &quot;description&quot;: &quot;A String&quot;, # The description of the Model.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
    &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
      &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
    },
    &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
    &quot;explanationSpec&quot;: { # Specification of Model explanation. # The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob.
      &quot;metadata&quot;: { # Metadata describing the Model&#x27;s input and output for explanation. # Optional. Metadata describing the Model&#x27;s input and output for explanation.
        &quot;featureAttributionsSchemaUri&quot;: &quot;A String&quot;, # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        &quot;inputs&quot;: { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
          &quot;a_key&quot;: { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
            &quot;denseShapeTensorName&quot;: &quot;A String&quot;, # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
            &quot;encodedBaselines&quot;: [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
              &quot;&quot;,
            ],
            &quot;encodedTensorName&quot;: &quot;A String&quot;, # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
            &quot;encoding&quot;: &quot;A String&quot;, # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
            &quot;featureValueDomain&quot;: { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
              &quot;maxValue&quot;: 3.14, # The maximum permissible value for this feature.
              &quot;minValue&quot;: 3.14, # The minimum permissible value for this feature.
              &quot;originalMean&quot;: 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
              &quot;originalStddev&quot;: 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
            },
            &quot;groupName&quot;: &quot;A String&quot;, # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
            &quot;indexFeatureMapping&quot;: [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
              &quot;A String&quot;,
            ],
            &quot;indicesTensorName&quot;: &quot;A String&quot;, # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
            &quot;inputBaselines&quot;: [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature&#x27;s input in the instance[]. The schema of any single instance may be specified via Endpoint&#x27;s DeployedModels&#x27; Model&#x27;s PredictSchemata&#x27;s instance_schema_uri.
              &quot;&quot;,
            ],
            &quot;inputTensorName&quot;: &quot;A String&quot;, # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
            &quot;modality&quot;: &quot;A String&quot;, # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
            &quot;visualization&quot;: { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
              &quot;clipPercentLowerbound&quot;: 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
              &quot;clipPercentUpperbound&quot;: 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
              &quot;colorMap&quot;: &quot;A String&quot;, # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
              &quot;overlayType&quot;: &quot;A String&quot;, # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
              &quot;polarity&quot;: &quot;A String&quot;, # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
              &quot;type&quot;: &quot;A String&quot;, # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
            },
          },
        },
        &quot;latentSpaceSource&quot;: &quot;A String&quot;, # Name of the source to generate embeddings for example based explanations.
        &quot;outputs&quot;: { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
          &quot;a_key&quot;: { # Metadata of the prediction output to be explained.
            &quot;displayNameMappingKey&quot;: &quot;A String&quot;, # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
            &quot;indexDisplayNameMapping&quot;: &quot;&quot;, # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It&#x27;s not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
            &quot;outputTensorName&quot;: &quot;A String&quot;, # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
          },
        },
      },
      &quot;parameters&quot;: { # Parameters to configure explaining for Model&#x27;s predictions. # Required. Parameters that configure explaining of the Model&#x27;s predictions.
        &quot;examples&quot;: { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
          &quot;exampleGcsSource&quot;: { # The Cloud Storage input instances. # The Cloud Storage input instances.
            &quot;dataFormat&quot;: &quot;A String&quot;, # The format in which instances are given, if not specified, assume it&#x27;s JSONL format. Currently only JSONL format is supported.
            &quot;gcsSource&quot;: { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
              &quot;uris&quot;: [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
                &quot;A String&quot;,
              ],
            },
          },
          &quot;nearestNeighborSearchConfig&quot;: &quot;&quot;, # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
          &quot;neighborCount&quot;: 42, # The number of neighbors to return when querying for examples.
          &quot;presets&quot;: { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
            &quot;modality&quot;: &quot;A String&quot;, # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
            &quot;query&quot;: &quot;A String&quot;, # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
          },
        },
        &quot;integratedGradientsAttribution&quot;: { # An attribution method that computes the Aumann-Shapley value taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
          &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
            &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
          },
          &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
            &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
              &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                { # Noise sigma for a single feature.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                  &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                },
              ],
            },
            &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
            &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
          },
          &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
        },
        &quot;outputIndices&quot;: [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it&#x27;s explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
          &quot;&quot;,
        ],
        &quot;sampledShapleyAttribution&quot;: { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
          &quot;pathCount&quot;: 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
        },
        &quot;topK&quot;: 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
        &quot;xraiAttribution&quot;: { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
          &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
            &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
          },
          &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
            &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
              &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                { # Noise sigma for a single feature.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                  &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                },
              ],
            },
            &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
            &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
          },
          &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
        },
      },
    },
    &quot;labels&quot;: { # The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
    &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
    &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    &quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
      &quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
      &quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
    },
    &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
    &quot;originalModelInfo&quot;: { # Contains information about the original Model if this Model is a copy. # Output only. If this Model is a copy of another Model, this contains info about the original.
      &quot;model&quot;: &quot;A String&quot;, # Output only. The resource name of the Model this Model is a copy of, including the revision. Format: `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
    },
    &quot;pipelineJob&quot;: &quot;A String&quot;, # Optional. This field is populated if the model is produced by a pipeline job.
    &quot;predictSchemata&quot;: { # Contains the schemata used in Model&#x27;s predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # The schemata that describe formats of the Model&#x27;s predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.
      &quot;instanceSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;parametersSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;predictionSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    },
    &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
    &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
    &quot;supportedDeploymentResourcesTypes&quot;: [ # Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.
      &quot;A String&quot;,
    ],
    &quot;supportedExportFormats&quot;: [ # Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
      { # Represents export format supported by the Model. All formats export to Google Cloud Storage.
        &quot;exportableContents&quot;: [ # Output only. The content of this Model that may be exported.
          &quot;A String&quot;,
        ],
        &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.
      },
    ],
    &quot;supportedInputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
      &quot;A String&quot;,
    ],
    &quot;supportedOutputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
      &quot;A String&quot;,
    ],
    &quot;trainingPipeline&quot;: &quot;A String&quot;, # Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was most recently updated.
    &quot;versionAliases&quot;: [ # User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.
      &quot;A String&quot;,
    ],
    &quot;versionCreateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was created.
    &quot;versionDescription&quot;: &quot;A String&quot;, # The description of this version.
    &quot;versionId&quot;: &quot;A String&quot;, # Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
    &quot;versionUpdateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was most recently updated.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the TrainingPipeline.
  &quot;parentModel&quot;: &quot;A String&quot;, # Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
  &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of the pipeline.
  &quot;trainingTaskDefinition&quot;: &quot;A String&quot;, # Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
  &quot;trainingTaskInputs&quot;: &quot;&quot;, # Required. The training task&#x27;s parameter(s), as specified in the training_task_definition&#x27;s `inputs`.
  &quot;trainingTaskMetadata&quot;: &quot;&quot;, # Output only. The metadata information as specified in the training_task_definition&#x27;s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline&#x27;s training_task_definition contains `metadata` object.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was most recently updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI&#x27;s Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of this TrainingPipeline.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if model_to_upload is not set separately.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the pipeline&#x27;s state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;inputDataConfig&quot;: { # Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. # Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline&#x27;s training_task_definition should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the training_task_definition, then it should be assumed that the TrainingPipeline does not depend on this configuration.
    &quot;annotationSchemaUri&quot;: &quot;A String&quot;, # Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
    &quot;annotationsFilter&quot;: &quot;A String&quot;, # Applicable only to Datasets that have DataItems and Annotations. A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.
    &quot;bigqueryDestination&quot;: { # The BigQuery location for the output content. # Only applicable to custom training with tabular Dataset with BigQuery source. The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name `dataset___` where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, `training`, `validation` and `test`. * AIP_DATA_FORMAT = &quot;bigquery&quot;. * AIP_TRAINING_DATA_URI = &quot;bigquery_destination.dataset___.training&quot; * AIP_VALIDATION_DATA_URI = &quot;bigquery_destination.dataset___.validation&quot; * AIP_TEST_DATA_URI = &quot;bigquery_destination.dataset___.test&quot;
      &quot;outputUri&quot;: &quot;A String&quot;, # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
    },
    &quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline&#x27;s training_task_definition. For tabular Datasets, all their data is exported to training, to pick and choose from.
    &quot;filterSplit&quot;: { # Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as &#x27;-&#x27; (the minus sign). Supported only for unstructured Datasets. # Split based on the provided filters for each set.
      &quot;testFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
      &quot;trainingFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to train the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
      &quot;validationFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to validate the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
    },
    &quot;fractionSplit&quot;: { # Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test. # Split based on fractions defining the size of each set.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;gcsDestination&quot;: { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory. The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: &quot;gs://.../training-*.jsonl&quot; * AIP_DATA_FORMAT = &quot;jsonl&quot; for non-tabular data, &quot;csv&quot; for tabular data * AIP_TRAINING_DATA_URI = &quot;gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}&quot; * AIP_VALIDATION_DATA_URI = &quot;gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}&quot; * AIP_TEST_DATA_URI = &quot;gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}&quot;
      &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. Google Cloud Storage URI to output directory. If the uri doesn&#x27;t end with &#x27;/&#x27;, a &#x27;/&#x27; will be automatically appended. The directory is created if it doesn&#x27;t exist.
    },
    &quot;persistMlUseAssignment&quot;: True or False, # Whether to persist the ML use assignment to data item system labels.
    &quot;predefinedSplit&quot;: { # Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on a predefined key.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The value of the key (either the label&#x27;s value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
    },
    &quot;savedQueryId&quot;: &quot;A String&quot;, # Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.
    &quot;stratifiedSplit&quot;: { # Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value &quot;A&quot;, 25% value &quot;B&quot;, and 25% value &quot;C&quot;, and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value &quot;A&quot; for the specified column, about 25% having the value &quot;B&quot;, and about 25% having the value &quot;C&quot;. Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the distribution of the specified column.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The key provided must be for a categorical column.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;timestampSplit&quot;: { # Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The values of the key (the values in the column) must be in RFC 3339 `date-time` format, where `time-offset` = `&quot;Z&quot;` (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
  },
  &quot;labels&quot;: { # The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;modelId&quot;: &quot;A String&quot;, # Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
  &quot;modelToUpload&quot;: { # A trained machine learning Model. # Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline&#x27;s training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline&#x27;s state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload&#x27;s resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
    &quot;artifactUri&quot;: &quot;A String&quot;, # Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
    &quot;baseModelSource&quot;: { # User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. # Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
      &quot;genieSource&quot;: { # Contains information about the source of the models generated from Generative AI Studio. # Information about the base model of Genie models.
        &quot;baseModelUri&quot;: &quot;A String&quot;, # Required. The public base model URI.
      },
      &quot;modelGardenSource&quot;: { # Contains information about the source of the models generated from Model Garden. # Source information of Model Garden models.
        &quot;publicModelName&quot;: &quot;A String&quot;, # Required. The model garden source model resource name.
        &quot;skipHfModelCache&quot;: True or False, # Optional. Whether to avoid pulling the model from the HF cache.
        &quot;versionId&quot;: &quot;A String&quot;, # Optional. The model garden source model version ID.
      },
    },
    &quot;checkpoints&quot;: [ # Optional. Output only. The checkpoints of the model.
      { # Describes the machine learning model version checkpoint.
        &quot;checkpointId&quot;: &quot;A String&quot;, # The ID of the checkpoint.
        &quot;epoch&quot;: &quot;A String&quot;, # The epoch of the checkpoint.
        &quot;step&quot;: &quot;A String&quot;, # The step of the checkpoint.
      },
    ],
    &quot;containerSpec&quot;: { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
      &quot;args&quot;: [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`&#x27;s &quot;default parameters&quot; form. If you don&#x27;t specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don&#x27;t specify this field and don&#x27;t specify the `command` field, then the container&#x27;s [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        &quot;A String&quot;,
      ],
      &quot;command&quot;: [ # Immutable. Specifies the command that runs when the container starts. This overrides the container&#x27;s [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`&#x27;s &quot;exec&quot; form, not its &quot;shell&quot; form. If you do not specify this field, then the container&#x27;s `ENTRYPOINT` runs, in conjunction with the args field or the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container&#x27;s `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        &quot;A String&quot;,
      ],
      &quot;deploymentTimeout&quot;: &quot;A String&quot;, # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
      &quot;env&quot;: [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { &quot;name&quot;: &quot;VAR_1&quot;, &quot;value&quot;: &quot;foo&quot; }, { &quot;name&quot;: &quot;VAR_2&quot;, &quot;value&quot;: &quot;$(VAR_1) bar&quot; } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        { # Represents an environment variable present in a Container or Python Module.
          &quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
          &quot;value&quot;: &quot;A String&quot;, # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
        },
      ],
      &quot;grpcPorts&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
        { # Represents a network port in a container.
          &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
        },
      ],
      &quot;healthProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
      &quot;healthRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container&#x27;s IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
      &quot;imageUri&quot;: &quot;A String&quot;, # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI&#x27;s [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
      &quot;invokeRoutePrefix&quot;: &quot;A String&quot;, # Immutable. Invoke route prefix for the custom container. &quot;/*&quot; is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: &quot;/invoke/foo/bar&quot;, however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
      &quot;livenessProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
      &quot;ports&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { &quot;containerPort&quot;: 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        { # Represents a network port in a container.
          &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
        },
      ],
      &quot;predictRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container&#x27;s IP address and port. Vertex AI then returns the container&#x27;s response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
      &quot;sharedMemorySizeMb&quot;: &quot;A String&quot;, # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
      &quot;startupProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was uploaded into Vertex AI.
    &quot;dataStats&quot;: { # Stats of data used for train or evaluate the Model. # Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config.
      &quot;testAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.
      &quot;testDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.
      &quot;trainingAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for training this Model.
      &quot;trainingDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for training this Model.
      &quot;validationAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for validating this Model during training.
      &quot;validationDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for validating this Model during training.
    },
    &quot;defaultCheckpointId&quot;: &quot;A String&quot;, # The default checkpoint id of a model version.
    &quot;deployedModels&quot;: [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
      { # Points to a DeployedModel.
        &quot;checkpointId&quot;: &quot;A String&quot;, # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
        &quot;deployedModelId&quot;: &quot;A String&quot;, # Immutable. An ID of a DeployedModel in the above Endpoint.
        &quot;endpoint&quot;: &quot;A String&quot;, # Immutable. A resource name of an Endpoint.
      },
    ],
    &quot;description&quot;: &quot;A String&quot;, # The description of the Model.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
    &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
      &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
    },
    &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
    &quot;explanationSpec&quot;: { # Specification of Model explanation. # The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob.
      &quot;metadata&quot;: { # Metadata describing the Model&#x27;s input and output for explanation. # Optional. Metadata describing the Model&#x27;s input and output for explanation.
        &quot;featureAttributionsSchemaUri&quot;: &quot;A String&quot;, # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        &quot;inputs&quot;: { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
          &quot;a_key&quot;: { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
            &quot;denseShapeTensorName&quot;: &quot;A String&quot;, # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
            &quot;encodedBaselines&quot;: [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
              &quot;&quot;,
            ],
            &quot;encodedTensorName&quot;: &quot;A String&quot;, # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
            &quot;encoding&quot;: &quot;A String&quot;, # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
            &quot;featureValueDomain&quot;: { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
              &quot;maxValue&quot;: 3.14, # The maximum permissible value for this feature.
              &quot;minValue&quot;: 3.14, # The minimum permissible value for this feature.
              &quot;originalMean&quot;: 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
              &quot;originalStddev&quot;: 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
            },
            &quot;groupName&quot;: &quot;A String&quot;, # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
            &quot;indexFeatureMapping&quot;: [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
              &quot;A String&quot;,
            ],
            &quot;indicesTensorName&quot;: &quot;A String&quot;, # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
            &quot;inputBaselines&quot;: [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature&#x27;s input in the instance[]. The schema of any single instance may be specified via Endpoint&#x27;s DeployedModels&#x27; Model&#x27;s PredictSchemata&#x27;s instance_schema_uri.
              &quot;&quot;,
            ],
            &quot;inputTensorName&quot;: &quot;A String&quot;, # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
            &quot;modality&quot;: &quot;A String&quot;, # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
            &quot;visualization&quot;: { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
              &quot;clipPercentLowerbound&quot;: 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
              &quot;clipPercentUpperbound&quot;: 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
              &quot;colorMap&quot;: &quot;A String&quot;, # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
              &quot;overlayType&quot;: &quot;A String&quot;, # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
              &quot;polarity&quot;: &quot;A String&quot;, # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
              &quot;type&quot;: &quot;A String&quot;, # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
            },
          },
        },
        &quot;latentSpaceSource&quot;: &quot;A String&quot;, # Name of the source to generate embeddings for example based explanations.
        &quot;outputs&quot;: { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
          &quot;a_key&quot;: { # Metadata of the prediction output to be explained.
            &quot;displayNameMappingKey&quot;: &quot;A String&quot;, # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
            &quot;indexDisplayNameMapping&quot;: &quot;&quot;, # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It&#x27;s not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
            &quot;outputTensorName&quot;: &quot;A String&quot;, # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
          },
        },
      },
      &quot;parameters&quot;: { # Parameters to configure explaining for Model&#x27;s predictions. # Required. Parameters that configure explaining of the Model&#x27;s predictions.
        &quot;examples&quot;: { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
          &quot;exampleGcsSource&quot;: { # The Cloud Storage input instances. # The Cloud Storage input instances.
            &quot;dataFormat&quot;: &quot;A String&quot;, # The format in which instances are given, if not specified, assume it&#x27;s JSONL format. Currently only JSONL format is supported.
            &quot;gcsSource&quot;: { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
              &quot;uris&quot;: [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
                &quot;A String&quot;,
              ],
            },
          },
          &quot;nearestNeighborSearchConfig&quot;: &quot;&quot;, # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
          &quot;neighborCount&quot;: 42, # The number of neighbors to return when querying for examples.
          &quot;presets&quot;: { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
            &quot;modality&quot;: &quot;A String&quot;, # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
            &quot;query&quot;: &quot;A String&quot;, # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
          },
        },
        &quot;integratedGradientsAttribution&quot;: { # An attribution method that computes the Aumann-Shapley value taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
          &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
            &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
          },
          &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
            &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
              &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                { # Noise sigma for a single feature.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                  &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                },
              ],
            },
            &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
            &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
          },
          &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
        },
        &quot;outputIndices&quot;: [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it&#x27;s explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
          &quot;&quot;,
        ],
        &quot;sampledShapleyAttribution&quot;: { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
          &quot;pathCount&quot;: 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
        },
        &quot;topK&quot;: 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
        &quot;xraiAttribution&quot;: { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
          &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
            &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
          },
          &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
            &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
              &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                { # Noise sigma for a single feature.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                  &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                },
              ],
            },
            &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
            &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
          },
          &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
        },
      },
    },
    &quot;labels&quot;: { # The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
    &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
    &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    &quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
      &quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
      &quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
    },
    &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
    &quot;originalModelInfo&quot;: { # Contains information about the original Model if this Model is a copy. # Output only. If this Model is a copy of another Model, this contains info about the original.
      &quot;model&quot;: &quot;A String&quot;, # Output only. The resource name of the Model this Model is a copy of, including the revision. Format: `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
    },
    &quot;pipelineJob&quot;: &quot;A String&quot;, # Optional. This field is populated if the model is produced by a pipeline job.
    &quot;predictSchemata&quot;: { # Contains the schemata used in Model&#x27;s predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # The schemata that describe formats of the Model&#x27;s predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.
      &quot;instanceSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;parametersSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;predictionSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    },
    &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
    &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
    &quot;supportedDeploymentResourcesTypes&quot;: [ # Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.
      &quot;A String&quot;,
    ],
    &quot;supportedExportFormats&quot;: [ # Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
      { # Represents export format supported by the Model. All formats export to Google Cloud Storage.
        &quot;exportableContents&quot;: [ # Output only. The content of this Model that may be exported.
          &quot;A String&quot;,
        ],
        &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.
      },
    ],
    &quot;supportedInputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
      &quot;A String&quot;,
    ],
    &quot;supportedOutputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
      &quot;A String&quot;,
    ],
    &quot;trainingPipeline&quot;: &quot;A String&quot;, # Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was most recently updated.
    &quot;versionAliases&quot;: [ # User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.
      &quot;A String&quot;,
    ],
    &quot;versionCreateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was created.
    &quot;versionDescription&quot;: &quot;A String&quot;, # The description of this version.
    &quot;versionId&quot;: &quot;A String&quot;, # Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
    &quot;versionUpdateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was most recently updated.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the TrainingPipeline.
  &quot;parentModel&quot;: &quot;A String&quot;, # Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
  &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of the pipeline.
  &quot;trainingTaskDefinition&quot;: &quot;A String&quot;, # Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
  &quot;trainingTaskInputs&quot;: &quot;&quot;, # Required. The training task&#x27;s parameter(s), as specified in the training_task_definition&#x27;s `inputs`.
  &quot;trainingTaskMetadata&quot;: &quot;&quot;, # Output only. The metadata information as specified in the training_task_definition&#x27;s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline&#x27;s training_task_definition contains `metadata` object.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was most recently updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a TrainingPipeline.

Args:
  name: string, Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a TrainingPipeline.

Args:
  name: string, Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI&#x27;s Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of this TrainingPipeline.
  &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if model_to_upload is not set separately.
    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
  },
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the pipeline&#x27;s state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;inputDataConfig&quot;: { # Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. # Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline&#x27;s training_task_definition should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the training_task_definition, then it should be assumed that the TrainingPipeline does not depend on this configuration.
    &quot;annotationSchemaUri&quot;: &quot;A String&quot;, # Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
    &quot;annotationsFilter&quot;: &quot;A String&quot;, # Applicable only to Datasets that have DataItems and Annotations. A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.
    &quot;bigqueryDestination&quot;: { # The BigQuery location for the output content. # Only applicable to custom training with tabular Dataset with BigQuery source. The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name `dataset___` where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, `training`, `validation` and `test`. * AIP_DATA_FORMAT = &quot;bigquery&quot;. * AIP_TRAINING_DATA_URI = &quot;bigquery_destination.dataset___.training&quot; * AIP_VALIDATION_DATA_URI = &quot;bigquery_destination.dataset___.validation&quot; * AIP_TEST_DATA_URI = &quot;bigquery_destination.dataset___.test&quot;
      &quot;outputUri&quot;: &quot;A String&quot;, # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
    },
    &quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline&#x27;s training_task_definition. For tabular Datasets, all their data is exported to training, to pick and choose from.
    &quot;filterSplit&quot;: { # Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as &#x27;-&#x27; (the minus sign). Supported only for unstructured Datasets. # Split based on the provided filters for each set.
      &quot;testFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
      &quot;trainingFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to train the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
      &quot;validationFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to validate the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
    },
    &quot;fractionSplit&quot;: { # Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test. # Split based on fractions defining the size of each set.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;gcsDestination&quot;: { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory. The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: &quot;gs://.../training-*.jsonl&quot; * AIP_DATA_FORMAT = &quot;jsonl&quot; for non-tabular data, &quot;csv&quot; for tabular data * AIP_TRAINING_DATA_URI = &quot;gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}&quot; * AIP_VALIDATION_DATA_URI = &quot;gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}&quot; * AIP_TEST_DATA_URI = &quot;gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}&quot;
      &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. Google Cloud Storage URI to output directory. If the uri doesn&#x27;t end with &#x27;/&#x27;, a &#x27;/&#x27; will be automatically appended. The directory is created if it doesn&#x27;t exist.
    },
    &quot;persistMlUseAssignment&quot;: True or False, # Whether to persist the ML use assignment to data item system labels.
    &quot;predefinedSplit&quot;: { # Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on a predefined key.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The value of the key (either the label&#x27;s value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
    },
    &quot;savedQueryId&quot;: &quot;A String&quot;, # Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.
    &quot;stratifiedSplit&quot;: { # Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value &quot;A&quot;, 25% value &quot;B&quot;, and 25% value &quot;C&quot;, and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value &quot;A&quot; for the specified column, about 25% having the value &quot;B&quot;, and about 25% having the value &quot;C&quot;. Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the distribution of the specified column.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The key provided must be for a categorical column.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
    &quot;timestampSplit&quot;: { # Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.
      &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The values of the key (the values in the column) must be in RFC 3339 `date-time` format, where `time-offset` = `&quot;Z&quot;` (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
      &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
      &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
      &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
    },
  },
  &quot;labels&quot;: { # The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;modelId&quot;: &quot;A String&quot;, # Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
  &quot;modelToUpload&quot;: { # A trained machine learning Model. # Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline&#x27;s training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline&#x27;s state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload&#x27;s resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
    &quot;artifactUri&quot;: &quot;A String&quot;, # Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
    &quot;baseModelSource&quot;: { # User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. # Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
      &quot;genieSource&quot;: { # Contains information about the source of the models generated from Generative AI Studio. # Information about the base model of Genie models.
        &quot;baseModelUri&quot;: &quot;A String&quot;, # Required. The public base model URI.
      },
      &quot;modelGardenSource&quot;: { # Contains information about the source of the models generated from Model Garden. # Source information of Model Garden models.
        &quot;publicModelName&quot;: &quot;A String&quot;, # Required. The model garden source model resource name.
        &quot;skipHfModelCache&quot;: True or False, # Optional. Whether to avoid pulling the model from the HF cache.
        &quot;versionId&quot;: &quot;A String&quot;, # Optional. The model garden source model version ID.
      },
    },
    &quot;checkpoints&quot;: [ # Optional. Output only. The checkpoints of the model.
      { # Describes the machine learning model version checkpoint.
        &quot;checkpointId&quot;: &quot;A String&quot;, # The ID of the checkpoint.
        &quot;epoch&quot;: &quot;A String&quot;, # The epoch of the checkpoint.
        &quot;step&quot;: &quot;A String&quot;, # The step of the checkpoint.
      },
    ],
    &quot;containerSpec&quot;: { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
      &quot;args&quot;: [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`&#x27;s &quot;default parameters&quot; form. If you don&#x27;t specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don&#x27;t specify this field and don&#x27;t specify the `command` field, then the container&#x27;s [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        &quot;A String&quot;,
      ],
      &quot;command&quot;: [ # Immutable. Specifies the command that runs when the container starts. This overrides the container&#x27;s [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`&#x27;s &quot;exec&quot; form, not its &quot;shell&quot; form. If you do not specify this field, then the container&#x27;s `ENTRYPOINT` runs, in conjunction with the args field or the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container&#x27;s `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        &quot;A String&quot;,
      ],
      &quot;deploymentTimeout&quot;: &quot;A String&quot;, # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
      &quot;env&quot;: [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { &quot;name&quot;: &quot;VAR_1&quot;, &quot;value&quot;: &quot;foo&quot; }, { &quot;name&quot;: &quot;VAR_2&quot;, &quot;value&quot;: &quot;$(VAR_1) bar&quot; } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        { # Represents an environment variable present in a Container or Python Module.
          &quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
          &quot;value&quot;: &quot;A String&quot;, # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
        },
      ],
      &quot;grpcPorts&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
        { # Represents a network port in a container.
          &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
        },
      ],
      &quot;healthProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
      &quot;healthRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container&#x27;s IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
      &quot;imageUri&quot;: &quot;A String&quot;, # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI&#x27;s [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
      &quot;invokeRoutePrefix&quot;: &quot;A String&quot;, # Immutable. Invoke route prefix for the custom container. &quot;/*&quot; is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: &quot;/invoke/foo/bar&quot;, however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
      &quot;livenessProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
      &quot;ports&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { &quot;containerPort&quot;: 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
        { # Represents a network port in a container.
          &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
        },
      ],
      &quot;predictRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container&#x27;s IP address and port. Vertex AI then returns the container&#x27;s response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
      &quot;sharedMemorySizeMb&quot;: &quot;A String&quot;, # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
      &quot;startupProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
        &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
          &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
            &quot;A String&quot;,
          ],
        },
        &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
        &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
          &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
          &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
        },
        &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
          &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
          &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
            { # HttpHeader describes a custom header to be used in HTTP probes
              &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
              &quot;value&quot;: &quot;A String&quot;, # The header field value
            },
          ],
          &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
        },
        &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
        &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
        &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
        &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
          &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
          &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
        },
        &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
      },
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was uploaded into Vertex AI.
    &quot;dataStats&quot;: { # Stats of data used for train or evaluate the Model. # Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config.
      &quot;testAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.
      &quot;testDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.
      &quot;trainingAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for training this Model.
      &quot;trainingDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for training this Model.
      &quot;validationAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for validating this Model during training.
      &quot;validationDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for validating this Model during training.
    },
    &quot;defaultCheckpointId&quot;: &quot;A String&quot;, # The default checkpoint id of a model version.
    &quot;deployedModels&quot;: [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
      { # Points to a DeployedModel.
        &quot;checkpointId&quot;: &quot;A String&quot;, # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
        &quot;deployedModelId&quot;: &quot;A String&quot;, # Immutable. An ID of a DeployedModel in the above Endpoint.
        &quot;endpoint&quot;: &quot;A String&quot;, # Immutable. A resource name of an Endpoint.
      },
    ],
    &quot;description&quot;: &quot;A String&quot;, # The description of the Model.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
    &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
      &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
    },
    &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
    &quot;explanationSpec&quot;: { # Specification of Model explanation. # The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob.
      &quot;metadata&quot;: { # Metadata describing the Model&#x27;s input and output for explanation. # Optional. Metadata describing the Model&#x27;s input and output for explanation.
        &quot;featureAttributionsSchemaUri&quot;: &quot;A String&quot;, # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        &quot;inputs&quot;: { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
          &quot;a_key&quot;: { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
            &quot;denseShapeTensorName&quot;: &quot;A String&quot;, # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
            &quot;encodedBaselines&quot;: [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
              &quot;&quot;,
            ],
            &quot;encodedTensorName&quot;: &quot;A String&quot;, # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
            &quot;encoding&quot;: &quot;A String&quot;, # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
            &quot;featureValueDomain&quot;: { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
              &quot;maxValue&quot;: 3.14, # The maximum permissible value for this feature.
              &quot;minValue&quot;: 3.14, # The minimum permissible value for this feature.
              &quot;originalMean&quot;: 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
              &quot;originalStddev&quot;: 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
            },
            &quot;groupName&quot;: &quot;A String&quot;, # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
            &quot;indexFeatureMapping&quot;: [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
              &quot;A String&quot;,
            ],
            &quot;indicesTensorName&quot;: &quot;A String&quot;, # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
            &quot;inputBaselines&quot;: [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature&#x27;s input in the instance[]. The schema of any single instance may be specified via Endpoint&#x27;s DeployedModels&#x27; Model&#x27;s PredictSchemata&#x27;s instance_schema_uri.
              &quot;&quot;,
            ],
            &quot;inputTensorName&quot;: &quot;A String&quot;, # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
            &quot;modality&quot;: &quot;A String&quot;, # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
            &quot;visualization&quot;: { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
              &quot;clipPercentLowerbound&quot;: 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
              &quot;clipPercentUpperbound&quot;: 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
              &quot;colorMap&quot;: &quot;A String&quot;, # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
              &quot;overlayType&quot;: &quot;A String&quot;, # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
              &quot;polarity&quot;: &quot;A String&quot;, # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
              &quot;type&quot;: &quot;A String&quot;, # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
            },
          },
        },
        &quot;latentSpaceSource&quot;: &quot;A String&quot;, # Name of the source to generate embeddings for example based explanations.
        &quot;outputs&quot;: { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
          &quot;a_key&quot;: { # Metadata of the prediction output to be explained.
            &quot;displayNameMappingKey&quot;: &quot;A String&quot;, # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
            &quot;indexDisplayNameMapping&quot;: &quot;&quot;, # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It&#x27;s not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
            &quot;outputTensorName&quot;: &quot;A String&quot;, # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
          },
        },
      },
      &quot;parameters&quot;: { # Parameters to configure explaining for Model&#x27;s predictions. # Required. Parameters that configure explaining of the Model&#x27;s predictions.
        &quot;examples&quot;: { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
          &quot;exampleGcsSource&quot;: { # The Cloud Storage input instances. # The Cloud Storage input instances.
            &quot;dataFormat&quot;: &quot;A String&quot;, # The format in which instances are given, if not specified, assume it&#x27;s JSONL format. Currently only JSONL format is supported.
            &quot;gcsSource&quot;: { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
              &quot;uris&quot;: [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
                &quot;A String&quot;,
              ],
            },
          },
          &quot;nearestNeighborSearchConfig&quot;: &quot;&quot;, # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
          &quot;neighborCount&quot;: 42, # The number of neighbors to return when querying for examples.
          &quot;presets&quot;: { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
            &quot;modality&quot;: &quot;A String&quot;, # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
            &quot;query&quot;: &quot;A String&quot;, # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
          },
        },
        &quot;integratedGradientsAttribution&quot;: { # An attribution method that computes the Aumann-Shapley value taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
          &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
            &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
          },
          &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
            &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
              &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                { # Noise sigma for a single feature.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                  &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                },
              ],
            },
            &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
            &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
          },
          &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
        },
        &quot;outputIndices&quot;: [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it&#x27;s explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
          &quot;&quot;,
        ],
        &quot;sampledShapleyAttribution&quot;: { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
          &quot;pathCount&quot;: 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
        },
        &quot;topK&quot;: 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
        &quot;xraiAttribution&quot;: { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
          &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
            &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
          },
          &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
            &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
              &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                { # Noise sigma for a single feature.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                  &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                },
              ],
            },
            &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
            &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
          },
          &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
        },
      },
    },
    &quot;labels&quot;: { # The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
    &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
    &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    &quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
      &quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
      &quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
    },
    &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
    &quot;originalModelInfo&quot;: { # Contains information about the original Model if this Model is a copy. # Output only. If this Model is a copy of another Model, this contains info about the original.
      &quot;model&quot;: &quot;A String&quot;, # Output only. The resource name of the Model this Model is a copy of, including the revision. Format: `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
    },
    &quot;pipelineJob&quot;: &quot;A String&quot;, # Optional. This field is populated if the model is produced by a pipeline job.
    &quot;predictSchemata&quot;: { # Contains the schemata used in Model&#x27;s predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # The schemata that describe formats of the Model&#x27;s predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.
      &quot;instanceSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;parametersSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;predictionSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    },
    &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
    &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
    &quot;supportedDeploymentResourcesTypes&quot;: [ # Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.
      &quot;A String&quot;,
    ],
    &quot;supportedExportFormats&quot;: [ # Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
      { # Represents export format supported by the Model. All formats export to Google Cloud Storage.
        &quot;exportableContents&quot;: [ # Output only. The content of this Model that may be exported.
          &quot;A String&quot;,
        ],
        &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.
      },
    ],
    &quot;supportedInputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
      &quot;A String&quot;,
    ],
    &quot;supportedOutputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
      &quot;A String&quot;,
    ],
    &quot;trainingPipeline&quot;: &quot;A String&quot;, # Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was most recently updated.
    &quot;versionAliases&quot;: [ # User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.
      &quot;A String&quot;,
    ],
    &quot;versionCreateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was created.
    &quot;versionDescription&quot;: &quot;A String&quot;, # The description of this version.
    &quot;versionId&quot;: &quot;A String&quot;, # Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
    &quot;versionUpdateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was most recently updated.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the TrainingPipeline.
  &quot;parentModel&quot;: &quot;A String&quot;, # Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
  &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of the pipeline.
  &quot;trainingTaskDefinition&quot;: &quot;A String&quot;, # Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
  &quot;trainingTaskInputs&quot;: &quot;&quot;, # Required. The training task&#x27;s parameter(s), as specified in the training_task_definition&#x27;s `inputs`.
  &quot;trainingTaskMetadata&quot;: &quot;&quot;, # Output only. The metadata information as specified in the training_task_definition&#x27;s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline&#x27;s training_task_definition contains `metadata` object.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was most recently updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code>
  <pre>Lists TrainingPipelines in a Location.

Args:
  parent: string, Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}` (required)
  filter: string, The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`&lt;`, `&lt;=`,`&gt;`, `&gt;=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=&quot;PIPELINE_STATE_SUCCEEDED&quot; AND display_name:&quot;my_pipeline_*&quot;` * `state!=&quot;PIPELINE_STATE_FAILED&quot; OR display_name=&quot;my_pipeline&quot;` * `NOT display_name=&quot;my_pipeline&quot;` * `create_time&gt;&quot;2021-05-18T00:00:00Z&quot;` * `training_task_definition:&quot;*automl_text_classification*&quot;`
  pageSize: integer, The standard list page size.
  pageToken: string, The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.
  readMask: string, Mask specifying which fields to read.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for PipelineService.ListTrainingPipelines
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass to ListTrainingPipelinesRequest.page_token to obtain that page.
  &quot;trainingPipelines&quot;: [ # List of TrainingPipelines in the requested page.
    { # The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI&#x27;s Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The user-defined name of this TrainingPipeline.
      &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if model_to_upload is not set separately.
        &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
      },
      &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.
      &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when the pipeline&#x27;s state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
        &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
        &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
          },
        ],
        &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      &quot;inputDataConfig&quot;: { # Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. # Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline&#x27;s training_task_definition should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the training_task_definition, then it should be assumed that the TrainingPipeline does not depend on this configuration.
        &quot;annotationSchemaUri&quot;: &quot;A String&quot;, # Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.
        &quot;annotationsFilter&quot;: &quot;A String&quot;, # Applicable only to Datasets that have DataItems and Annotations. A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.
        &quot;bigqueryDestination&quot;: { # The BigQuery location for the output content. # Only applicable to custom training with tabular Dataset with BigQuery source. The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name `dataset___` where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, `training`, `validation` and `test`. * AIP_DATA_FORMAT = &quot;bigquery&quot;. * AIP_TRAINING_DATA_URI = &quot;bigquery_destination.dataset___.training&quot; * AIP_VALIDATION_DATA_URI = &quot;bigquery_destination.dataset___.validation&quot; * AIP_TEST_DATA_URI = &quot;bigquery_destination.dataset___.test&quot;
          &quot;outputUri&quot;: &quot;A String&quot;, # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
        },
        &quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline&#x27;s training_task_definition. For tabular Datasets, all their data is exported to training, to pick and choose from.
        &quot;filterSplit&quot;: { # Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as &#x27;-&#x27; (the minus sign). Supported only for unstructured Datasets. # Split based on the provided filters for each set.
          &quot;testFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
          &quot;trainingFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to train the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
          &quot;validationFilter&quot;: &quot;A String&quot;, # Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to validate the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.
        },
        &quot;fractionSplit&quot;: { # Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test. # Split based on fractions defining the size of each set.
          &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
          &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
          &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
        },
        &quot;gcsDestination&quot;: { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory. The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: &quot;gs://.../training-*.jsonl&quot; * AIP_DATA_FORMAT = &quot;jsonl&quot; for non-tabular data, &quot;csv&quot; for tabular data * AIP_TRAINING_DATA_URI = &quot;gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}&quot; * AIP_VALIDATION_DATA_URI = &quot;gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}&quot; * AIP_TEST_DATA_URI = &quot;gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}&quot;
          &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. Google Cloud Storage URI to output directory. If the uri doesn&#x27;t end with &#x27;/&#x27;, a &#x27;/&#x27; will be automatically appended. The directory is created if it doesn&#x27;t exist.
        },
        &quot;persistMlUseAssignment&quot;: True or False, # Whether to persist the ML use assignment to data item system labels.
        &quot;predefinedSplit&quot;: { # Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on a predefined key.
          &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The value of the key (either the label&#x27;s value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
        },
        &quot;savedQueryId&quot;: &quot;A String&quot;, # Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.
        &quot;stratifiedSplit&quot;: { # Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value &quot;A&quot;, 25% value &quot;B&quot;, and 25% value &quot;C&quot;, and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value &quot;A&quot; for the specified column, about 25% having the value &quot;B&quot;, and about 25% having the value &quot;C&quot;. Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the distribution of the specified column.
          &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The key provided must be for a categorical column.
          &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
          &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
          &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
        },
        &quot;timestampSplit&quot;: { # Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set. Supported only for tabular Datasets. # Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.
          &quot;key&quot;: &quot;A String&quot;, # Required. The key is a name of one of the Dataset&#x27;s data columns. The values of the key (the values in the column) must be in RFC 3339 `date-time` format, where `time-offset` = `&quot;Z&quot;` (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.
          &quot;testFraction&quot;: 3.14, # The fraction of the input data that is to be used to evaluate the Model.
          &quot;trainingFraction&quot;: 3.14, # The fraction of the input data that is to be used to train the Model.
          &quot;validationFraction&quot;: 3.14, # The fraction of the input data that is to be used to validate the Model.
        },
      },
      &quot;labels&quot;: { # The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;modelId&quot;: &quot;A String&quot;, # Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
      &quot;modelToUpload&quot;: { # A trained machine learning Model. # Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline&#x27;s training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline&#x27;s state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload&#x27;s resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.
        &quot;artifactUri&quot;: &quot;A String&quot;, # Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
        &quot;baseModelSource&quot;: { # User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. # Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
          &quot;genieSource&quot;: { # Contains information about the source of the models generated from Generative AI Studio. # Information about the base model of Genie models.
            &quot;baseModelUri&quot;: &quot;A String&quot;, # Required. The public base model URI.
          },
          &quot;modelGardenSource&quot;: { # Contains information about the source of the models generated from Model Garden. # Source information of Model Garden models.
            &quot;publicModelName&quot;: &quot;A String&quot;, # Required. The model garden source model resource name.
            &quot;skipHfModelCache&quot;: True or False, # Optional. Whether to avoid pulling the model from the HF cache.
            &quot;versionId&quot;: &quot;A String&quot;, # Optional. The model garden source model version ID.
          },
        },
        &quot;checkpoints&quot;: [ # Optional. Output only. The checkpoints of the model.
          { # Describes the machine learning model version checkpoint.
            &quot;checkpointId&quot;: &quot;A String&quot;, # The ID of the checkpoint.
            &quot;epoch&quot;: &quot;A String&quot;, # The epoch of the checkpoint.
            &quot;step&quot;: &quot;A String&quot;, # The step of the checkpoint.
          },
        ],
        &quot;containerSpec&quot;: { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
          &quot;args&quot;: [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`&#x27;s &quot;default parameters&quot; form. If you don&#x27;t specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don&#x27;t specify this field and don&#x27;t specify the `command` field, then the container&#x27;s [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
            &quot;A String&quot;,
          ],
          &quot;command&quot;: [ # Immutable. Specifies the command that runs when the container starts. This overrides the container&#x27;s [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`&#x27;s &quot;exec&quot; form, not its &quot;shell&quot; form. If you do not specify this field, then the container&#x27;s `ENTRYPOINT` runs, in conjunction with the args field or the container&#x27;s [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container&#x27;s `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container&#x27;s `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
            &quot;A String&quot;,
          ],
          &quot;deploymentTimeout&quot;: &quot;A String&quot;, # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
          &quot;env&quot;: [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { &quot;name&quot;: &quot;VAR_1&quot;, &quot;value&quot;: &quot;foo&quot; }, { &quot;name&quot;: &quot;VAR_2&quot;, &quot;value&quot;: &quot;$(VAR_1) bar&quot; } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
            { # Represents an environment variable present in a Container or Python Module.
              &quot;name&quot;: &quot;A String&quot;, # Required. Name of the environment variable. Must be a valid C identifier.
              &quot;value&quot;: &quot;A String&quot;, # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
            },
          ],
          &quot;grpcPorts&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
            { # Represents a network port in a container.
              &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
            },
          ],
          &quot;healthProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
            &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
              &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                &quot;A String&quot;,
              ],
            },
            &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
            &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
              &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
              &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
            },
            &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
              &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
              &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
                { # HttpHeader describes a custom header to be used in HTTP probes
                  &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                  &quot;value&quot;: &quot;A String&quot;, # The header field value
                },
              ],
              &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
              &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
            },
            &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
            &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
            &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
            &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
              &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
              &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
            },
            &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
          },
          &quot;healthRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container&#x27;s IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
          &quot;imageUri&quot;: &quot;A String&quot;, # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI&#x27;s [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
          &quot;invokeRoutePrefix&quot;: &quot;A String&quot;, # Immutable. Invoke route prefix for the custom container. &quot;/*&quot; is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: &quot;/invoke/foo/bar&quot;, however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
          &quot;livenessProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
            &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
              &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                &quot;A String&quot;,
              ],
            },
            &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
            &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
              &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
              &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
            },
            &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
              &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
              &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
                { # HttpHeader describes a custom header to be used in HTTP probes
                  &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                  &quot;value&quot;: &quot;A String&quot;, # The header field value
                },
              ],
              &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
              &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
            },
            &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
            &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
            &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
            &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
              &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
              &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
            },
            &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
          },
          &quot;ports&quot;: [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { &quot;containerPort&quot;: 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
            { # Represents a network port in a container.
              &quot;containerPort&quot;: 42, # The number of the port to expose on the pod&#x27;s IP address. Must be a valid port number, between 1 and 65535 inclusive.
            },
          ],
          &quot;predictRoute&quot;: &quot;A String&quot;, # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container&#x27;s IP address and port. Vertex AI then returns the container&#x27;s response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`&#x27;s ports field. If you don&#x27;t specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
          &quot;sharedMemorySizeMb&quot;: &quot;A String&quot;, # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
          &quot;startupProbe&quot;: { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
            &quot;exec&quot;: { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
              &quot;command&quot;: [ # Command is the command line to execute inside the container, the working directory for the command is root (&#x27;/&#x27;) in the container&#x27;s filesystem. The command is simply exec&#x27;d, it is not run inside a shell, so traditional shell instructions (&#x27;|&#x27;, etc) won&#x27;t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                &quot;A String&quot;,
              ],
            },
            &quot;failureThreshold&quot;: 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument &#x27;failureThreshold&#x27;.
            &quot;grpc&quot;: { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
              &quot;port&quot;: 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
              &quot;service&quot;: &quot;A String&quot;, # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
            },
            &quot;httpGet&quot;: { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
              &quot;host&quot;: &quot;A String&quot;, # Host name to connect to, defaults to the model serving container&#x27;s IP. You probably want to set &quot;Host&quot; in httpHeaders instead.
              &quot;httpHeaders&quot;: [ # Custom headers to set in the request. HTTP allows repeated headers.
                { # HttpHeader describes a custom header to be used in HTTP probes
                  &quot;name&quot;: &quot;A String&quot;, # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                  &quot;value&quot;: &quot;A String&quot;, # The header field value
                },
              ],
              &quot;path&quot;: &quot;A String&quot;, # Path to access on the HTTP server.
              &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              &quot;scheme&quot;: &quot;A String&quot;, # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are &quot;HTTP&quot; or &quot;HTTPS&quot;.
            },
            &quot;initialDelaySeconds&quot;: 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument &#x27;initialDelaySeconds&#x27;.
            &quot;periodSeconds&quot;: 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument &#x27;periodSeconds&#x27;.
            &quot;successThreshold&quot;: 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument &#x27;successThreshold&#x27;.
            &quot;tcpSocket&quot;: { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
              &quot;host&quot;: &quot;A String&quot;, # Optional: Host name to connect to, defaults to the model serving container&#x27;s IP.
              &quot;port&quot;: 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
            },
            &quot;timeoutSeconds&quot;: 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument &#x27;timeoutSeconds&#x27;.
          },
        },
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was uploaded into Vertex AI.
        &quot;dataStats&quot;: { # Stats of data used for train or evaluate the Model. # Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config.
          &quot;testAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.
          &quot;testDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.
          &quot;trainingAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for training this Model.
          &quot;trainingDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for training this Model.
          &quot;validationAnnotationsCount&quot;: &quot;A String&quot;, # Number of Annotations that are used for validating this Model during training.
          &quot;validationDataItemsCount&quot;: &quot;A String&quot;, # Number of DataItems that were used for validating this Model during training.
        },
        &quot;defaultCheckpointId&quot;: &quot;A String&quot;, # The default checkpoint id of a model version.
        &quot;deployedModels&quot;: [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
          { # Points to a DeployedModel.
            &quot;checkpointId&quot;: &quot;A String&quot;, # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
            &quot;deployedModelId&quot;: &quot;A String&quot;, # Immutable. An ID of a DeployedModel in the above Endpoint.
            &quot;endpoint&quot;: &quot;A String&quot;, # Immutable. A resource name of an Endpoint.
          },
        ],
        &quot;description&quot;: &quot;A String&quot;, # The description of the Model.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
        &quot;encryptionSpec&quot;: { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
          &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
        },
        &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
        &quot;explanationSpec&quot;: { # Specification of Model explanation. # The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob.
          &quot;metadata&quot;: { # Metadata describing the Model&#x27;s input and output for explanation. # Optional. Metadata describing the Model&#x27;s input and output for explanation.
            &quot;featureAttributionsSchemaUri&quot;: &quot;A String&quot;, # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
            &quot;inputs&quot;: { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
              &quot;a_key&quot;: { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
                &quot;denseShapeTensorName&quot;: &quot;A String&quot;, # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
                &quot;encodedBaselines&quot;: [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
                  &quot;&quot;,
                ],
                &quot;encodedTensorName&quot;: &quot;A String&quot;, # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
                &quot;encoding&quot;: &quot;A String&quot;, # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
                &quot;featureValueDomain&quot;: { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
                  &quot;maxValue&quot;: 3.14, # The maximum permissible value for this feature.
                  &quot;minValue&quot;: 3.14, # The minimum permissible value for this feature.
                  &quot;originalMean&quot;: 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
                  &quot;originalStddev&quot;: 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
                },
                &quot;groupName&quot;: &quot;A String&quot;, # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
                &quot;indexFeatureMapping&quot;: [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
                  &quot;A String&quot;,
                ],
                &quot;indicesTensorName&quot;: &quot;A String&quot;, # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
                &quot;inputBaselines&quot;: [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature&#x27;s input in the instance[]. The schema of any single instance may be specified via Endpoint&#x27;s DeployedModels&#x27; Model&#x27;s PredictSchemata&#x27;s instance_schema_uri.
                  &quot;&quot;,
                ],
                &quot;inputTensorName&quot;: &quot;A String&quot;, # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
                &quot;modality&quot;: &quot;A String&quot;, # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
                &quot;visualization&quot;: { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
                  &quot;clipPercentLowerbound&quot;: 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
                  &quot;clipPercentUpperbound&quot;: 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
                  &quot;colorMap&quot;: &quot;A String&quot;, # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
                  &quot;overlayType&quot;: &quot;A String&quot;, # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
                  &quot;polarity&quot;: &quot;A String&quot;, # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
                  &quot;type&quot;: &quot;A String&quot;, # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
                },
              },
            },
            &quot;latentSpaceSource&quot;: &quot;A String&quot;, # Name of the source to generate embeddings for example based explanations.
            &quot;outputs&quot;: { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
              &quot;a_key&quot;: { # Metadata of the prediction output to be explained.
                &quot;displayNameMappingKey&quot;: &quot;A String&quot;, # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
                &quot;indexDisplayNameMapping&quot;: &quot;&quot;, # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It&#x27;s not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
                &quot;outputTensorName&quot;: &quot;A String&quot;, # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
              },
            },
          },
          &quot;parameters&quot;: { # Parameters to configure explaining for Model&#x27;s predictions. # Required. Parameters that configure explaining of the Model&#x27;s predictions.
            &quot;examples&quot;: { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
              &quot;exampleGcsSource&quot;: { # The Cloud Storage input instances. # The Cloud Storage input instances.
                &quot;dataFormat&quot;: &quot;A String&quot;, # The format in which instances are given, if not specified, assume it&#x27;s JSONL format. Currently only JSONL format is supported.
                &quot;gcsSource&quot;: { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
                  &quot;uris&quot;: [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
                    &quot;A String&quot;,
                  ],
                },
              },
              &quot;nearestNeighborSearchConfig&quot;: &quot;&quot;, # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
              &quot;neighborCount&quot;: 42, # The number of neighbors to return when querying for examples.
              &quot;presets&quot;: { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
                &quot;modality&quot;: &quot;A String&quot;, # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
                &quot;query&quot;: &quot;A String&quot;, # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
              },
            },
            &quot;integratedGradientsAttribution&quot;: { # An attribution method that computes the Aumann-Shapley value taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
              &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
                &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
              },
              &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
                &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
                  &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                    { # Noise sigma for a single feature.
                      &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                      &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                    },
                  ],
                },
                &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
                &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
              },
              &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
            },
            &quot;outputIndices&quot;: [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it&#x27;s explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
              &quot;&quot;,
            ],
            &quot;sampledShapleyAttribution&quot;: { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
              &quot;pathCount&quot;: 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
            },
            &quot;topK&quot;: 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
            &quot;xraiAttribution&quot;: { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model&#x27;s fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
              &quot;blurBaselineConfig&quot;: { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
                &quot;maxBlurSigma&quot;: 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
              },
              &quot;smoothGradConfig&quot;: { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
                &quot;featureNoiseSigma&quot;: { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
                  &quot;noiseSigma&quot;: [ # Noise sigma per feature. No noise is added to features that are not set.
                    { # Noise sigma for a single feature.
                      &quot;name&quot;: &quot;A String&quot;, # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
                      &quot;sigma&quot;: 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
                    },
                  ],
                },
                &quot;noiseSigma&quot;: 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
                &quot;noisySampleCount&quot;: 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
              },
              &quot;stepCount&quot;: 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
            },
          },
        },
        &quot;labels&quot;: { # The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
        &quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
        &quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        &quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
          &quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
          &quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
        },
        &quot;name&quot;: &quot;A String&quot;, # The resource name of the Model.
        &quot;originalModelInfo&quot;: { # Contains information about the original Model if this Model is a copy. # Output only. If this Model is a copy of another Model, this contains info about the original.
          &quot;model&quot;: &quot;A String&quot;, # Output only. The resource name of the Model this Model is a copy of, including the revision. Format: `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
        },
        &quot;pipelineJob&quot;: &quot;A String&quot;, # Optional. This field is populated if the model is produced by a pipeline job.
        &quot;predictSchemata&quot;: { # Contains the schemata used in Model&#x27;s predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # The schemata that describe formats of the Model&#x27;s predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.
          &quot;instanceSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
          &quot;parametersSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
          &quot;predictionSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        },
        &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
        &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
        &quot;supportedDeploymentResourcesTypes&quot;: [ # Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.
          &quot;A String&quot;,
        ],
        &quot;supportedExportFormats&quot;: [ # Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
          { # Represents export format supported by the Model. All formats export to Google Cloud Storage.
            &quot;exportableContents&quot;: [ # Output only. The content of this Model that may be exported.
              &quot;A String&quot;,
            ],
            &quot;id&quot;: &quot;A String&quot;, # Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.
          },
        ],
        &quot;supportedInputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
          &quot;A String&quot;,
        ],
        &quot;supportedOutputStorageFormats&quot;: [ # Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn&#x27;t support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.
          &quot;A String&quot;,
        ],
        &quot;trainingPipeline&quot;: &quot;A String&quot;, # Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
        &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this Model was most recently updated.
        &quot;versionAliases&quot;: [ # User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.
          &quot;A String&quot;,
        ],
        &quot;versionCreateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was created.
        &quot;versionDescription&quot;: &quot;A String&quot;, # The description of this version.
        &quot;versionId&quot;: &quot;A String&quot;, # Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
        &quot;versionUpdateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this version was most recently updated.
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the TrainingPipeline.
      &quot;parentModel&quot;: &quot;A String&quot;, # Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.
      &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.
      &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of the pipeline.
      &quot;trainingTaskDefinition&quot;: &quot;A String&quot;, # Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      &quot;trainingTaskInputs&quot;: &quot;&quot;, # Required. The training task&#x27;s parameter(s), as specified in the training_task_definition&#x27;s `inputs`.
      &quot;trainingTaskMetadata&quot;: &quot;&quot;, # Output only. The metadata information as specified in the training_task_definition&#x27;s `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline&#x27;s training_task_definition contains `metadata` object.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when the TrainingPipeline was most recently updated.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>